<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>Irrlicht 3D Engine: irr::gui::ICursorControl Class Reference</title>

<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { searchBox.OnSelectItem(0); });
</script>

</head>
<body>
<div id="top"><!-- do not remove this div! -->


<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  
  <td id="projectlogo"><img alt="Logo" src="irrlichtlogo.png"/></td>
  
  
  <td style="padding-left: 0.5em;">
   <div id="projectname">Irrlicht 3D Engine
   
   </div>
   
  </td>
  
  
  
   
   <td>        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
</td>
   
  
 </tr>
 </tbody>
</table>
</div>

<!-- Generated by Doxygen 1.7.5.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="dynsections.js"></script>
</div>
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
  initNavTree('classirr_1_1gui_1_1_i_cursor_control.html','');
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a>  </div>
  <div class="headertitle">
<div class="title">irr::gui::ICursorControl Class Reference</div>  </div>
</div>
<div class="contents">
<!-- doxytag: class="irr::gui::ICursorControl" --><!-- doxytag: inherits="irr::IReferenceCounted" -->
<p>Interface to manipulate the mouse cursor.  
 <a href="classirr_1_1gui_1_1_i_cursor_control.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="_i_cursor_control_8h_source.html">ICursorControl.h</a>&gt;</code></p>
<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
  <img id="dynsection-0-trigger" src="closed.png" alt="+"/> Inheritance diagram for irr::gui::ICursorControl:</div>
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
 <div class="center">
  <img src="classirr_1_1gui_1_1_i_cursor_control.png" usemap="#irr::gui::ICursorControl_map" alt=""/>
  <map id="irr::gui::ICursorControl_map" name="irr::gui::ICursorControl_map">
<area href="classirr_1_1_i_reference_counted.html" title="Base class of most objects of the Irrlicht Engine." alt="irr::IReferenceCounted" shape="rect" coords="0,0,140,24"/>
</map>
 </div></div>

<p><a href="classirr_1_1gui_1_1_i_cursor_control-members.html">List of all members.</a></p>
<h2><a name="pub-methods"></a>
Public Member Functions</h2>
<ul>
<li>virtual <a class="el" href="namespaceirr_1_1gui.html#aefee802dd632c5735703e40ef40f879b">ECURSOR_ICON</a> <a class="el" href="classirr_1_1gui_1_1_i_cursor_control.html#a102ff455c70595886281e636ef063d3b">addIcon</a> (const <a class="el" href="structirr_1_1gui_1_1_s_cursor_sprite.html">gui::SCursorSprite</a> &amp;icon)
<dl class="el"><dd class="mdescRight">Add a custom sprite as cursor icon.  <a href="#a102ff455c70595886281e636ef063d3b"></a><br/></dl><li>virtual void <a class="el" href="classirr_1_1gui_1_1_i_cursor_control.html#a3e7c8cb1f03e1ccc31fcc3c30f717762">changeIcon</a> (<a class="el" href="namespaceirr_1_1gui.html#aefee802dd632c5735703e40ef40f879b">ECURSOR_ICON</a> iconId, const <a class="el" href="structirr_1_1gui_1_1_s_cursor_sprite.html">gui::SCursorSprite</a> &amp;sprite)
<dl class="el"><dd class="mdescRight">replace a cursor icon.  <a href="#a3e7c8cb1f03e1ccc31fcc3c30f717762"></a><br/></dl><li>virtual <a class="el" href="namespaceirr_1_1gui.html#aefee802dd632c5735703e40ef40f879b">ECURSOR_ICON</a> <a class="el" href="classirr_1_1gui_1_1_i_cursor_control.html#a6c08f4adefe397b8054296151f15f2ad">getActiveIcon</a> () const 
<dl class="el"><dd class="mdescRight">Gets the currently active icon.  <a href="#a6c08f4adefe397b8054296151f15f2ad"></a><br/></dl><li>virtual <a class="el" href="namespaceirr_1_1gui.html#abbd186f9cfba2f805d98248df226acef">ECURSOR_PLATFORM_BEHAVIOR</a> <a class="el" href="classirr_1_1gui_1_1_i_cursor_control.html#a0d0b11d3d3d5d0adb6e0b0de78edd2a8">getPlatformBehavior</a> () const 
<dl class="el"><dd class="mdescRight">Return platform specific behavior.  <a href="#a0d0b11d3d3d5d0adb6e0b0de78edd2a8"></a><br/></dl><li>virtual const core::position2d<br class="typebreak"/>
&lt; <a class="el" href="namespaceirr.html#ac66849b7a6ed16e30ebede579f9b47c6">s32</a> &gt; &amp; <a class="el" href="classirr_1_1gui_1_1_i_cursor_control.html#a65d9f6e734baa02be69b7e9f5fbdd565">getPosition</a> ()=0
<dl class="el"><dd class="mdescRight">Returns the current position of the mouse cursor.  <a href="#a65d9f6e734baa02be69b7e9f5fbdd565"></a><br/></dl><li>virtual core::position2d&lt; <a class="el" href="namespaceirr.html#a0277be98d67dc26ff93b1a6a1d086b07">f32</a> &gt; <a class="el" href="classirr_1_1gui_1_1_i_cursor_control.html#a8ba1cb0ff11edc5fb32cdadddece09f8">getRelativePosition</a> ()=0
<dl class="el"><dd class="mdescRight">Returns the current position of the mouse cursor.  <a href="#a8ba1cb0ff11edc5fb32cdadddece09f8"></a><br/></dl><li>virtual <a class="el" href="namespaceirr_1_1core.html#ac79bc3704cf28bc1ab72d7cd1cae78d1">core::dimension2di</a> <a class="el" href="classirr_1_1gui_1_1_i_cursor_control.html#ad2c301e1c82366520913c270ef8d738c">getSupportedIconSize</a> () const 
<dl class="el"><dd class="mdescRight">Return a system-specific size which is supported for cursors. Larger icons will fail, smaller icons might work.  <a href="#ad2c301e1c82366520913c270ef8d738c"></a><br/></dl><li>virtual bool <a class="el" href="classirr_1_1gui_1_1_i_cursor_control.html#ae1d1ca4c1c3042388881fabda4e53a42">isVisible</a> () const =0
<dl class="el"><dd class="mdescRight">Returns if the cursor is currently visible.  <a href="#ae1d1ca4c1c3042388881fabda4e53a42"></a><br/></dl><li>virtual void <a class="el" href="classirr_1_1gui_1_1_i_cursor_control.html#af394700d5279b13cc0f2bcdad679469c">setActiveIcon</a> (<a class="el" href="namespaceirr_1_1gui.html#aefee802dd632c5735703e40ef40f879b">ECURSOR_ICON</a> iconId)
<dl class="el"><dd class="mdescRight">Sets the active cursor icon.  <a href="#af394700d5279b13cc0f2bcdad679469c"></a><br/></dl><li>virtual void <a class="el" href="classirr_1_1gui_1_1_i_cursor_control.html#ad7688bb200945f15877a598e8be53878">setPlatformBehavior</a> (<a class="el" href="namespaceirr_1_1gui.html#abbd186f9cfba2f805d98248df226acef">ECURSOR_PLATFORM_BEHAVIOR</a> behavior)
<dl class="el"><dd class="mdescRight">Set platform specific behavior flags.  <a href="#ad7688bb200945f15877a598e8be53878"></a><br/></dl><li>virtual void <a class="el" href="classirr_1_1gui_1_1_i_cursor_control.html#a951b5afe97fa21d98ce5360d96314306">setPosition</a> (const core::position2d&lt; <a class="el" href="namespaceirr.html#a0277be98d67dc26ff93b1a6a1d086b07">f32</a> &gt; &amp;pos)=0
<dl class="el"><dd class="mdescRight">Sets the new position of the cursor.  <a href="#a951b5afe97fa21d98ce5360d96314306"></a><br/></dl><li>virtual void <a class="el" href="classirr_1_1gui_1_1_i_cursor_control.html#adca41054684f73435c9b045520f7c83b">setPosition</a> (<a class="el" href="namespaceirr.html#a0277be98d67dc26ff93b1a6a1d086b07">f32</a> x, <a class="el" href="namespaceirr.html#a0277be98d67dc26ff93b1a6a1d086b07">f32</a> y)=0
<dl class="el"><dd class="mdescRight">Sets the new position of the cursor.  <a href="#adca41054684f73435c9b045520f7c83b"></a><br/></dl><li>virtual void <a class="el" href="classirr_1_1gui_1_1_i_cursor_control.html#a421c770ffc494f8f6082a16bef0feed2">setPosition</a> (const core::position2d&lt; <a class="el" href="namespaceirr.html#ac66849b7a6ed16e30ebede579f9b47c6">s32</a> &gt; &amp;pos)=0
<dl class="el"><dd class="mdescRight">Sets the new position of the cursor.  <a href="#a421c770ffc494f8f6082a16bef0feed2"></a><br/></dl><li>virtual void <a class="el" href="classirr_1_1gui_1_1_i_cursor_control.html#a3b0a59608d1d0810079349acfa01a79b">setPosition</a> (<a class="el" href="namespaceirr.html#ac66849b7a6ed16e30ebede579f9b47c6">s32</a> x, <a class="el" href="namespaceirr.html#ac66849b7a6ed16e30ebede579f9b47c6">s32</a> y)=0
<dl class="el"><dd class="mdescRight">Sets the new position of the cursor.  <a href="#a3b0a59608d1d0810079349acfa01a79b"></a><br/></dl><li>virtual void <a class="el" href="classirr_1_1gui_1_1_i_cursor_control.html#a2a7428ef716a60f8f4b86361a69b8770">setReferenceRect</a> (<a class="el" href="classirr_1_1core_1_1rect.html">core::rect</a>&lt; <a class="el" href="namespaceirr.html#ac66849b7a6ed16e30ebede579f9b47c6">s32</a> &gt; *rect=0)=0
<dl class="el"><dd class="mdescRight">Sets an absolute reference rect for setting and retrieving the cursor position.  <a href="#a2a7428ef716a60f8f4b86361a69b8770"></a><br/></dl><li>virtual void <a class="el" href="classirr_1_1gui_1_1_i_cursor_control.html#aceb41d68494e2b2076fbc6949b254c74">setVisible</a> (bool visible)=0
<dl class="el"><dd class="mdescRight">Changes the visible state of the mouse cursor.  <a href="#aceb41d68494e2b2076fbc6949b254c74"></a><br/></dl></ul>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Interface to manipulate the mouse cursor. </p>

<p>Definition at line <a class="el" href="_i_cursor_control_8h_source.html#l00097">97</a> of file <a class="el" href="_i_cursor_control_8h_source.html">ICursorControl.h</a>.</p>
</div><hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a102ff455c70595886281e636ef063d3b"></a><!-- doxytag: member="irr::gui::ICursorControl::addIcon" ref="a102ff455c70595886281e636ef063d3b" args="(const gui::SCursorSprite &amp;icon)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual <a class="el" href="namespaceirr_1_1gui.html#aefee802dd632c5735703e40ef40f879b">ECURSOR_ICON</a> irr::gui::ICursorControl::addIcon </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="structirr_1_1gui_1_1_s_cursor_sprite.html">gui::SCursorSprite</a> &amp;&#160;</td>
          <td class="paramname"><em>icon</em></td><td>)</td>
          <td><code> [inline, virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Add a custom sprite as cursor icon. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>Identification for the icon </dd></dl>

<p>Definition at line <a class="el" href="_i_cursor_control_8h_source.html#l00166">166</a> of file <a class="el" href="_i_cursor_control_8h_source.html">ICursorControl.h</a>.</p>

<p>References <a class="el" href="_i_cursor_control_8h_source.html#l00023">irr::gui::ECI_NORMAL</a>.</p>

</div>
</div>
<a class="anchor" id="a3e7c8cb1f03e1ccc31fcc3c30f717762"></a><!-- doxytag: member="irr::gui::ICursorControl::changeIcon" ref="a3e7c8cb1f03e1ccc31fcc3c30f717762" args="(ECURSOR_ICON iconId, const gui::SCursorSprite &amp;sprite)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void irr::gui::ICursorControl::changeIcon </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="namespaceirr_1_1gui.html#aefee802dd632c5735703e40ef40f879b">ECURSOR_ICON</a>&#160;</td>
          <td class="paramname"><em>iconId</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="structirr_1_1gui_1_1_s_cursor_sprite.html">gui::SCursorSprite</a> &amp;&#160;</td>
          <td class="paramname"><em>sprite</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td><code> [inline, virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>replace a cursor icon. </p>
<p>Changing cursor icons is so far only supported on Win32 and Linux Note that this only changes the icons within your application, system cursors outside your application will not be affected. </p>

<p>Definition at line <a class="el" href="_i_cursor_control_8h_source.html#l00173">173</a> of file <a class="el" href="_i_cursor_control_8h_source.html">ICursorControl.h</a>.</p>

</div>
</div>
<a class="anchor" id="a6c08f4adefe397b8054296151f15f2ad"></a><!-- doxytag: member="irr::gui::ICursorControl::getActiveIcon" ref="a6c08f4adefe397b8054296151f15f2ad" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual <a class="el" href="namespaceirr_1_1gui.html#aefee802dd632c5735703e40ef40f879b">ECURSOR_ICON</a> irr::gui::ICursorControl::getActiveIcon </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const<code> [inline, virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Gets the currently active icon. </p>

<p>Definition at line <a class="el" href="_i_cursor_control_8h_source.html#l00162">162</a> of file <a class="el" href="_i_cursor_control_8h_source.html">ICursorControl.h</a>.</p>

<p>References <a class="el" href="_i_cursor_control_8h_source.html#l00023">irr::gui::ECI_NORMAL</a>.</p>

</div>
</div>
<a class="anchor" id="a0d0b11d3d3d5d0adb6e0b0de78edd2a8"></a><!-- doxytag: member="irr::gui::ICursorControl::getPlatformBehavior" ref="a0d0b11d3d3d5d0adb6e0b0de78edd2a8" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual <a class="el" href="namespaceirr_1_1gui.html#abbd186f9cfba2f805d98248df226acef">ECURSOR_PLATFORM_BEHAVIOR</a> irr::gui::ICursorControl::getPlatformBehavior </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const<code> [inline, virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Return platform specific behavior. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>Behavior set by setPlatformBehavior or ECPB_NONE for platforms not implementing specific behaviors. </dd></dl>

<p>Definition at line <a class="el" href="_i_cursor_control_8h_source.html#l00184">184</a> of file <a class="el" href="_i_cursor_control_8h_source.html">ICursorControl.h</a>.</p>

<p>References <a class="el" href="_i_cursor_control_8h_source.html#l00085">irr::gui::ECPB_NONE</a>.</p>

</div>
</div>
<a class="anchor" id="a65d9f6e734baa02be69b7e9f5fbdd565"></a><!-- doxytag: member="irr::gui::ICursorControl::getPosition" ref="a65d9f6e734baa02be69b7e9f5fbdd565" args="()=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual const core::position2d&lt;<a class="el" href="namespaceirr.html#ac66849b7a6ed16e30ebede579f9b47c6">s32</a>&gt;&amp; irr::gui::ICursorControl::getPosition </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td><code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Returns the current position of the mouse cursor. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>Returns the current position of the cursor. The returned position is the position of the mouse cursor in pixel units. </dd></dl>

</div>
</div>
<a class="anchor" id="a8ba1cb0ff11edc5fb32cdadddece09f8"></a><!-- doxytag: member="irr::gui::ICursorControl::getRelativePosition" ref="a8ba1cb0ff11edc5fb32cdadddece09f8" args="()=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual core::position2d&lt;<a class="el" href="namespaceirr.html#a0277be98d67dc26ff93b1a6a1d086b07">f32</a>&gt; irr::gui::ICursorControl::getRelativePosition </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td><code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Returns the current position of the mouse cursor. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>Returns the current position of the cursor. The returned position is a value between (0.0f, 0.0f) and (1.0f, 1.0f), where (0.0f, 0.0f) is the top left corner and (1.0f, 1.0f) is the bottom right corner of the render window. </dd></dl>

</div>
</div>
<a class="anchor" id="ad2c301e1c82366520913c270ef8d738c"></a><!-- doxytag: member="irr::gui::ICursorControl::getSupportedIconSize" ref="ad2c301e1c82366520913c270ef8d738c" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual <a class="el" href="namespaceirr_1_1core.html#ac79bc3704cf28bc1ab72d7cd1cae78d1">core::dimension2di</a> irr::gui::ICursorControl::getSupportedIconSize </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const<code> [inline, virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Return a system-specific size which is supported for cursors. Larger icons will fail, smaller icons might work. </p>

<p>Definition at line <a class="el" href="_i_cursor_control_8h_source.html#l00176">176</a> of file <a class="el" href="_i_cursor_control_8h_source.html">ICursorControl.h</a>.</p>

</div>
</div>
<a class="anchor" id="ae1d1ca4c1c3042388881fabda4e53a42"></a><!-- doxytag: member="irr::gui::ICursorControl::isVisible" ref="ae1d1ca4c1c3042388881fabda4e53a42" args="() const =0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual bool irr::gui::ICursorControl::isVisible </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const<code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Returns if the cursor is currently visible. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>True if the cursor is visible, false if not. </dd></dl>

</div>
</div>
<a class="anchor" id="af394700d5279b13cc0f2bcdad679469c"></a><!-- doxytag: member="irr::gui::ICursorControl::setActiveIcon" ref="af394700d5279b13cc0f2bcdad679469c" args="(ECURSOR_ICON iconId)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void irr::gui::ICursorControl::setActiveIcon </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="namespaceirr_1_1gui.html#aefee802dd632c5735703e40ef40f879b">ECURSOR_ICON</a>&#160;</td>
          <td class="paramname"><em>iconId</em></td><td>)</td>
          <td><code> [inline, virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Sets the active cursor icon. </p>
<p>Setting cursor icons is so far only supported on Win32 and Linux </p>

<p>Definition at line <a class="el" href="_i_cursor_control_8h_source.html#l00159">159</a> of file <a class="el" href="_i_cursor_control_8h_source.html">ICursorControl.h</a>.</p>

</div>
</div>
<a class="anchor" id="ad7688bb200945f15877a598e8be53878"></a><!-- doxytag: member="irr::gui::ICursorControl::setPlatformBehavior" ref="ad7688bb200945f15877a598e8be53878" args="(ECURSOR_PLATFORM_BEHAVIOR behavior)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void irr::gui::ICursorControl::setPlatformBehavior </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="namespaceirr_1_1gui.html#abbd186f9cfba2f805d98248df226acef">ECURSOR_PLATFORM_BEHAVIOR</a>&#160;</td>
          <td class="paramname"><em>behavior</em></td><td>)</td>
          <td><code> [inline, virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Set platform specific behavior flags. </p>

<p>Definition at line <a class="el" href="_i_cursor_control_8h_source.html#l00179">179</a> of file <a class="el" href="_i_cursor_control_8h_source.html">ICursorControl.h</a>.</p>

</div>
</div>
<a class="anchor" id="a951b5afe97fa21d98ce5360d96314306"></a><!-- doxytag: member="irr::gui::ICursorControl::setPosition" ref="a951b5afe97fa21d98ce5360d96314306" args="(const core::position2d&lt; f32 &gt; &amp;pos)=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void irr::gui::ICursorControl::setPosition </td>
          <td>(</td>
          <td class="paramtype">const core::position2d&lt; <a class="el" href="namespaceirr.html#a0277be98d67dc26ff93b1a6a1d086b07">f32</a> &gt; &amp;&#160;</td>
          <td class="paramname"><em>pos</em></td><td>)</td>
          <td><code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Sets the new position of the cursor. </p>
<p>The position must be between (0.0f, 0.0f) and (1.0f, 1.0f), where (0.0f, 0.0f) is the top left corner and (1.0f, 1.0f) is the bottom right corner of the render window. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">pos</td><td>New position of the cursor. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="adca41054684f73435c9b045520f7c83b"></a><!-- doxytag: member="irr::gui::ICursorControl::setPosition" ref="adca41054684f73435c9b045520f7c83b" args="(f32 x, f32 y)=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void irr::gui::ICursorControl::setPosition </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="namespaceirr.html#a0277be98d67dc26ff93b1a6a1d086b07">f32</a>&#160;</td>
          <td class="paramname"><em>x</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="namespaceirr.html#a0277be98d67dc26ff93b1a6a1d086b07">f32</a>&#160;</td>
          <td class="paramname"><em>y</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td><code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Sets the new position of the cursor. </p>
<p>The position must be between (0.0f, 0.0f) and (1.0f, 1.0f), where (0.0f, 0.0f) is the top left corner and (1.0f, 1.0f) is the bottom right corner of the render window. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">x</td><td>New x-coord of the cursor. </td></tr>
    <tr><td class="paramname">y</td><td>New x-coord of the cursor. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="a421c770ffc494f8f6082a16bef0feed2"></a><!-- doxytag: member="irr::gui::ICursorControl::setPosition" ref="a421c770ffc494f8f6082a16bef0feed2" args="(const core::position2d&lt; s32 &gt; &amp;pos)=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void irr::gui::ICursorControl::setPosition </td>
          <td>(</td>
          <td class="paramtype">const core::position2d&lt; <a class="el" href="namespaceirr.html#ac66849b7a6ed16e30ebede579f9b47c6">s32</a> &gt; &amp;&#160;</td>
          <td class="paramname"><em>pos</em></td><td>)</td>
          <td><code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Sets the new position of the cursor. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">pos,:</td><td>New position of the cursor. The coordinates are pixel units. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="a3b0a59608d1d0810079349acfa01a79b"></a><!-- doxytag: member="irr::gui::ICursorControl::setPosition" ref="a3b0a59608d1d0810079349acfa01a79b" args="(s32 x, s32 y)=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void irr::gui::ICursorControl::setPosition </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="namespaceirr.html#ac66849b7a6ed16e30ebede579f9b47c6">s32</a>&#160;</td>
          <td class="paramname"><em>x</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="namespaceirr.html#ac66849b7a6ed16e30ebede579f9b47c6">s32</a>&#160;</td>
          <td class="paramname"><em>y</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td><code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Sets the new position of the cursor. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">x</td><td>New x-coord of the cursor. The coordinates are pixel units. </td></tr>
    <tr><td class="paramname">y</td><td>New y-coord of the cursor. The coordinates are pixel units. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="a2a7428ef716a60f8f4b86361a69b8770"></a><!-- doxytag: member="irr::gui::ICursorControl::setReferenceRect" ref="a2a7428ef716a60f8f4b86361a69b8770" args="(core::rect&lt; s32 &gt; *rect=0)=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void irr::gui::ICursorControl::setReferenceRect </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classirr_1_1core_1_1rect.html">core::rect</a>&lt; <a class="el" href="namespaceirr.html#ac66849b7a6ed16e30ebede579f9b47c6">s32</a> &gt; *&#160;</td>
          <td class="paramname"><em>rect</em> = <code>0</code></td><td>)</td>
          <td><code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Sets an absolute reference rect for setting and retrieving the cursor position. </p>
<p>If this rect is set, the cursor position is not being calculated relative to the rendering window but to this rect. You can set the rect pointer to 0 to disable this feature again. This feature is useful when rendering into parts of foreign windows for example in an editor. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">rect,:</td><td>A pointer to an reference rectangle or 0 to disable the reference rectangle. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="aceb41d68494e2b2076fbc6949b254c74"></a><!-- doxytag: member="irr::gui::ICursorControl::setVisible" ref="aceb41d68494e2b2076fbc6949b254c74" args="(bool visible)=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void irr::gui::ICursorControl::setVisible </td>
          <td>(</td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"><em>visible</em></td><td>)</td>
          <td><code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Changes the visible state of the mouse cursor. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">visible,:</td><td>The new visible state. If true, the cursor will be visible, if false, it will be invisible. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="_i_cursor_control_8h_source.html">ICursorControl.h</a></li>
</ul>
</div>
</div>
  <div id="nav-path" class="navpath">
    <ul>
      <li class="navelem"><a class="el" href="namespaceirr.html">irr</a>      </li>
      <li class="navelem"><a class="el" href="namespaceirr_1_1gui.html">gui</a>      </li>
      <li class="navelem"><a class="el" href="classirr_1_1gui_1_1_i_cursor_control.html">ICursorControl</a>      </li>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark">&#160;</span>Defines</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>


    <li class="footer">
<a href="http://irrlicht.sourceforge.net" target="_blank">Irrlicht 
Engine</a> Documentation &copy; 2003-2012 by Nikolaus Gebhardt. Generated on Sat Jul 9 2016 18:18:32 for Irrlicht 3D Engine by
<a href="http://www.doxygen.org/index.html" target="_blank">Doxygen</a> 1.7.5.1 </li>
   </ul>
 </div>


</body>
</html>
